home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / bbs / str_utilities3.lha / str.utils / docs / STR.Scroller.doc < prev    next >
Text File  |  1994-08-26  |  9KB  |  263 lines
  1.  
  2.                         The ST/R Utilities Package
  3.                                  Release 3
  4.  
  5.                                     By:
  6.  
  7.                             Douglas McLaughlin
  8.                                [Black Fire]
  9.  
  10. * All new or updated information since the last release will have a star in
  11.   the left column.
  12.  
  13. ------------------------------------------------------------------------------
  14.  
  15.                             STR.ScrollerCD.rexx
  16.                             STR.ScrollerFB.rexx
  17.                               STR.CDROM.rexx
  18.  
  19.  
  20. INSTALLATION:
  21.  
  22.  
  23.   File Locations:
  24.  
  25.     STR.ScrollerCD.rexx ---> Doors:STR.Utils/
  26.     STR.ScrollerFB.rexx ---> Doors:STR.Utils/
  27.     STR.CDROM.rexx      ---> Doors:STR.Utils/
  28.  
  29.     CreateList          ---> C: [or anywhere in your PATH....]
  30.     FileSort            ---> C: [or anywhere in your PATH....]
  31.     ls [or ls.030]      ---> C: [or anywhere in your PATH....]
  32.  
  33.       Don't forget to rename ls.030 to ls if you have a 68030 or better.
  34.  
  35.     FileScroll_AFR.Hlp     ---> BBS:TEXT/ENGLISH/
  36.     FileScroll_Browse.Hlp  ---> BBS:TEXT/ENGLISH/
  37.     FileScroll_Browse2.Hlp ---> BBS:TEXT/ENGLISH/
  38.     FileScroll_Main.Hlp    ---> BBS:TEXT/ENGLISH/
  39.     FileScroll_Main2.Hlp   ---> BBS:TEXT/ENGLISH/
  40.  
  41.   Install in the BBS:
  42.  
  43.     To install STR.ScrollerCD.rexx, use this line in your EX.BBSMenus file
  44.     in the "Global Commands" Area:
  45.  
  46. 566,  READCD,  0,  "1-32",  "\#0Doors:STR.Utils/STR.ScrollerCD.rexx\"
  47.  
  48.     To install STR.ScrollerFB.rexx, use this line in your EX.BBSMenus file
  49.     in the "Message/File Transfer" Area:
  50.  
  51. 168,  F,       0,  "1-32",  "\#0Doors:STR.Utils/STR.ScrollerFB.rexx\"
  52.  
  53.     To install STR.CDROM.rexx, create or add the following line to your
  54.     "Entry_Message" file in the BBS:FBASE/ directory:
  55.         
  56. \#0Doors:STR.Utils/STR.CDROM.rexx\
  57.  
  58.  
  59. REQUIREMENTS:
  60.  
  61.  
  62.   Any Amiga ;)
  63.  
  64.     The faster the better! =)
  65.  
  66.   OS 2.04+
  67.  
  68.     Untested with, but should work fine with, OS 3.0/3.1
  69.  
  70.   ARexx:
  71.   
  72.     RexxMast should be run in your s:user-startup.
  73.     rexxsupport.library should be installed in Libs:
  74.  
  75.   Excelsior! BBS v1.20p12+
  76.  
  77.     Works fine with v1.21 as well.
  78.  
  79.   Assignment to T:
  80.  
  81.     Preferably to RAM:T/ but can be anywhere.
  82.  
  83.  
  84. KNOWN BUGS:
  85.  
  86.  
  87.   Only ANSI callers have access to the FileScrollers due to the ANSI
  88.   intensive interface of the programs.
  89.  
  90.   Files marked in the STR.ScrollerFB.rexx program do not have their download
  91.   counter updated.  This is not really a bug, more of an over-sight.
  92.  
  93.   Both versions of the FileScroller had/has a problem with the format of the
  94.   European date.  I don't know if this is fixed yet, no one has reported back
  95.   to me on this.
  96.  
  97.   If the filename has a space in it, the Scroller can't do anything to it.
  98.   ie. View, Mark, etc.
  99.  
  100.   Excelsior! v1.21 returns the following Enforcer hit when the ARexx
  101.   MARKFILE command is executed:
  102.  
  103. BYTE-READ from 00000001                        PC: 07D68C3C
  104. USP:  07D150E8 SR: 0000 SW: 0751  (U0)(-)(-)  TCB: 07A7D138
  105. Data: 00000001 00000000 00000023 00000000 00000000 00000018 00000000 40000000
  106. Addr: 00000002 07A44858 00000001 07AA9428 07D05E68 07C9F67C 07D683F2 --------
  107. Stck: 07ADA5F9 07CFE7F4 07D683F2 07D88C3A 00000001 00000023 00000000 00000000
  108. Stck: 00000018 1EF6108F 00000000 07D15504 07C9F67C 07D151FC 07DA4D80 07AA9428
  109. Name: "Background CLI"  CLI: "BB"  Hunk 0000 Offset 00027294
  110.  
  111.   This is relatively harmless, but it has existed since v1.18!  If everyone
  112.   reports this, Tom may yet fix it!
  113.  
  114.  
  115. CONFIGURATION:
  116.  
  117.  
  118.   STR.ScrollerCD.rexx
  119.  
  120.     CDPath     - Path to your CD-ROM.  'NET:CD0/' or 'CD0:'
  121.  
  122.     Language   - Set to 1 for English, 0 for French.
  123.  
  124.     SysopLevel - Access level to get Sysop Menu.
  125.  
  126.     LogActive  - Set to 1 to log usage, 0 for no logs.
  127.  
  128.     LogFile    - Path and name of the file to keep the log in.
  129.  
  130.     DestDir    - Path to the directory to store extracted files in.
  131.  
  132.     Com.       - Archiver information.  Ensure that the necessary programs
  133.                  are in your PATH.
  134.  
  135.     cdpath.    - This is where you assign access levels to individual
  136.                  CD-ROMs.  Follow the examples by placing the name of the
  137.                  CD after the "cdpath." followed by an equals sign and the
  138.                  access level of that CD.  The first line assigns an access
  139.                  level to any CD's that aren't in the list yet.
  140.  
  141.     hidden     - Set this to the number of hidden directories.
  142.  
  143.     hidedir.   - Add in all the directories on CDs you don't want your users
  144.                  to see.  Be sure all directory names are in UPPERCASE.
  145.   
  146.   STR.ScrollerFB.rexx
  147.  
  148.     Language   - Set to 1 for English, 0 for French.
  149.  
  150.     SysopLevel - Access level to get Sysop Menu.
  151.  
  152.     LogActive  - Set to 1 to log usage, 0 for no logs.
  153.  
  154.     LogFile    - Path and name of the file to keep the log in.
  155.  
  156.     DestDir    - Path to the directory to store extracted files in.
  157.  
  158.     debug      - Always leave this at 0.
  159.  
  160.     stripnumfidl - Set this to 0 if you have NEVER run TransAmiga BBS.
  161.                    If you HAVE run TA and your file descriptions still
  162.                    have the [0] type download counters, setting this to
  163.                    1 will delete this part of the comment.
  164.  
  165.     Com.       - Archiver information.  Ensure that the necessary programs
  166.                  are in your PATH.
  167.  
  168.   STR.CDROM.rexx
  169.  
  170.     CDPath     - Path to your CD-ROM.  'NET:CD0/' or 'CD0:'
  171.  
  172.     cdpath.    - This is where you assign access levels to individual
  173.                  CD-ROMs.  Follow the examples by placing the name of the
  174.                  CD after the "cdpath." followed by an equals sign and the
  175.                  access level of that CD.  The first line assigns an access
  176.                  level to any CD's that aren't in the list yet.
  177.  
  178.  
  179. PURPOSE & FEATURES:
  180.  
  181.   STR.ScrollerCD.rexx
  182.  
  183.     This program allows sysops to use a single CD-ROM system with multiple
  184.     CD's.  Once the program is configured, you don't need to change a thing
  185.     each time you want to change a CD.  It allows you to assign access levels
  186.     to individual CD's and disallow users to see certain directories on your
  187.     CD-ROM's.  It allows users the option of using Files.BBS or similar
  188.     files on the CD-ROM for descriptions.  This program does NOT require
  189.     the STR.ScrollerFB.rexx program to run.
  190.  
  191.     If you have the Viewtek (VT) graphics viewer in your PATH, you can use
  192.     the un-documented (until now) G command at the Scroller's main menu to
  193.     view either .GIF or .JPG files on CD-ROM's.  Also, the V command, if
  194.     used on a .GIF or .JPG, will return the file's size and depth.
  195.  
  196.     The ScrollerCD program recognizes the following file names that could
  197.     possibly hold file descriptions:
  198.  
  199.       00_Index.txt
  200.       Files.BBS
  201.       Wildcat.txt
  202.       A file with the same name as the current directory with .txt extension.
  203.       A file in the CD0:Readme/ directory with the same name as the current
  204.         directory with .LST extension.
  205.  
  206.     The ScrollerCD searches for the description files in the above order.
  207.     If more than one of them exists on the CD-ROM, the ScrollerCD uses the
  208.     first one it finds.
  209.  
  210. *   ScrollerCD now ignores files that end in .readme for use on the AmiNet
  211. *   CD-ROMs.
  212.  
  213.   STR.ScrollerFB.rexx
  214.  
  215.     The program provides an alternate interface to the files in the File
  216.     Base.  It's much easier and more intuitive than the ANSI machine provided
  217.     in Excelsior!.  This program does NOT require the STR.ScrollerCD.rexx to
  218.     run.
  219.  
  220.     If you have the Viewtek (VT) graphics viewer in your PATH, you can use
  221.     the un-documented (until now) G command at the Scroller's main menu to
  222.     view either .GIF or .JPG files in the File Base.  Also, the V command, if
  223.     used on a .GIF or .JPG, will return the file's size and depth.
  224.  
  225.   STR.CDROM.rexx
  226.  
  227.     This program shows your users which CD-ROM is currently loaded.  If a
  228.     user does not have access to the current CD, then nothing is displayed.
  229.     This program does NOT require STR.ScrollerCD.rexx to run.
  230.  
  231.  
  232. HISTORY:
  233.  
  234.  
  235.   Version 3.52cd & 3.51fb:
  236.  
  237.     Made another change to the parsing of the European date format.  It now
  238.     supports both 20/7/1994 and 20.7.1994.
  239.  
  240.   Version 3.51cd:
  241.  
  242.     Made a minor change (yet again) to keep the ScrollerCD from entering the
  243.     BBS's main directory with the '<' command.  This "fix" should override
  244.     any other "glitches" ;)
  245.  
  246.     Reported By: Stace Cunningham @ 1:3604/60.0
  247.  
  248.   Version 3.5:
  249.  
  250.     All changes and additions are listed in the above text.
  251.  
  252.   The Past:
  253.  
  254.     The "FileScroller" program was originally created by a person whose
  255.     alias is "Merlin."  90% of both the CD and FB programs are his, I merely
  256.     made the the necessary changes/additions/deletions as appropriate for
  257.     either a CD-ROM or Excelsior!'s File Base.  All code that sets up the
  258.     file lists in the correct format for the Scroller is purely that of
  259.     the author of the STR.Utilites Package.
  260.  
  261.     The FileScroller went up through v3.4 before being abandoned by the
  262.     author, "Merlin."
  263.